home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1993 November / JCSM Shareware Collection - 1993-11.iso / cl040 / qslot32.lzh / QSLOT.DOC < prev    next >
Text File  |  1993-03-01  |  15KB  |  317 lines
  1.  
  2.                                Q-Slot  -  Version 3.2
  3.                       Copyright 1989-1993 by Motor City Software
  4.                                  All Rights Reserved
  5.  
  6.  
  7.     ╒══════════════════════════════════════════════════════════════════════════╕
  8.     │░░░░░░ LICENSING INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ Q-Slot 3.2 ░░░│
  9.     ╘══════════════════════════════════════════════════════════════════════════╛
  10.  
  11.                Motor City doors are  commercial programs marketed under the
  12.           "User  Supported"  or "Shareware"  concept.  You  are allowed  to
  13.           install  this  program on  Your  system  and evaluate  it  before
  14.           deciding whether to purchase a license to continue using it. This
  15.           program is not public domain or freeware. If you use this program
  16.           for more  than 30  days after  successful  installation, you  are
  17.           legally required to register it or remove all working copies from
  18.           your system.
  19.  
  20.                The  User Supported or  Shareware concept works  only if you
  21.           and  your  fellow sysops  support it.  If  you find  this program
  22.           useful, you  can register it for only  $15.00 in U.S. funds. This
  23.           will help offset the development costs, and encourage us to write
  24.           other programs  that might  be useful to  you. After all,  no one
  25.           likes to work for nothing! A Registration Form is included in the
  26.           RATS distribution archive.
  27.  
  28.              QSlot is Copyrighted 1990,91,92,93 by Motor City Software, ALL
  29.           RIGHTS  RESERVED. You may copy this program and documentation for
  30.           backup purposes. You also may copy and share UNMODIFIED copies of
  31.           the original  program archive.  The copyright notice  must remain
  32.           attached to all copies.
  33.  
  34.                You  may not sell Motor City Software products for a fee, or
  35.           distribute it  along with other products  without written permis-
  36.           sion of  Motor City Software,  nor may  you modify or  remove the
  37.           Copyright  Notice  from the  program  or  the documentation.  BBS
  38.           operators  who charge for access to their systems are exempt from
  39.           this provision as long  as no additional payment is  required for
  40.           access to Motor City Software products beyond basic file access.
  41.  
  42.                All  Motor City  Software  products are  extensively  tested
  43.           before being  publicly released, but  as with any  software, bugs
  44.           may still occur. Motor City Software products are provided as is,
  45.           and neither Motor City Software nor any BBS operator distributing
  46.           this  software is responsible for any  damage incurred during the
  47.           operation  of this  program.  You  are advised to test all  Motor
  48.           City  Software products thoroughly on  a backup copy  of your BBS
  49.           before putting them online.
  50.  
  51.                Comments, suggestions  and bug  reports are welcome.  If you
  52.           have any, you  may call  one of the  Motor City Software  Support
  53.           Systems listed in SUPPORT.DOC  and leave a message to  the Sysop.
  54.           If you're reporting a bug, please give as much detail as possible
  55.           about the problem you are having, your system  configuration, and
  56.           if  you  would be  willing to  test  possible corrections  to the
  57.           problem.
  58.  
  59.  
  60.     
  61.  
  62.     ╒══════════════════════════════════════════════════════════════════════════╕
  63.     │░░░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ Q-Slot 3.2 ░░░│
  64.     ╘══════════════════════════════════════════════════════════════════════════╛
  65.  
  66.       Q-Slot! is an online ANSI graphics "Slot Machine" door game for QuickBBS
  67.     and RemoteAccess BBS.
  68.  
  69.     It allows users to gamble their time remaining while online.  The program
  70.     is pretty straight forward and and easy to install.  It does require ANSI
  71.     graphics to be turned ON by the user and does require the DOS ANSI.SYS
  72.     driver to be installed on the host computer.  If a caller tries to run
  73.     Q-Slot! and does not have graphics turned on, the program will notify the
  74.     user that graphics are required.  It will then return control to the BBS.
  75.  
  76.     Q-Slot! allows the BBS Sysop to define the maximum number of turns allowed
  77.     per user, per day as well as the maximum number of minutes a user may win
  78.     while in the game.  Once a user has reached a maximum number of winable
  79.     minutes, the user is not allowed to access the game until the next day.
  80.     Once a user has reached the maximum number of turns per day Q-Slot! will
  81.     not allow the user to take any more turns.
  82.  
  83.  
  84.     
  85.  
  86.     ╒══════════════════════════════════════════════════════════════════════════╕
  87.     │░░░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ Q-Slot 3.2 ░░░│
  88.     ╘══════════════════════════════════════════════════════════════════════════╛
  89.  
  90.     NOTE: If you were running an older release of QSlot, please note the
  91.     node number is now 2 digits, ie QSLOT01.CFG rather than QSLOT1.CFG
  92.     You also need to delete the first line of the config file, as QSLot now
  93.     reads the drop files from the current directory.
  94.  
  95.     Q-Slot is easy to install.  A type 7 menu entry may be used, as follows:
  96.  
  97.     Optional Data :  D:\BBS\DOORS\QSLOT\QSLOT.EXE /N*N
  98.  
  99.     When executed, Q-Slot! will look for its configuration file QSLOT##.CFG
  100.     in the same directory that Q-Slot! is in. The ## is replaced by a 2 digit
  101.     node number.  Q-Slot! reads the first 6 lines of the configuration file
  102.     and gets its operating parameters.  Edit the QSLOT##.CFG file to suit your
  103.     needs. QSlot will read the ExitInfo.BBS and Dorinfo1.def file from the
  104.     current directory.
  105.  
  106.     LEAVE NO BLANK LINES between lines 1 through 6.
  107.  
  108.     The 7 lines represent the following parameters:
  109.  
  110.  
  111.           Line 1 - Time Bank Path
  112.  
  113.           This is the path to your Time Banking utility directory.  A trailing
  114.           backslash is appended if one is not already specified. This is
  115.           the path where Q-Slot! will write the file 'THEBANK.EXT' .
  116.  
  117.           Line 2 - Coin Value
  118.  
  119.           Coin_value is a number from 1 to 10.      This tells Q-Slot!
  120.           the value of a coin in minutes.  For example, if you enter
  121.           a value of 2, each coin will have a value of 2 minutes.  I
  122.           have found that a value of 2 works well.
  123.  
  124.           Line 3 - Maximum Winable Daily Minutes
  125.  
  126.           Max_Mins is a number from 1 to 1000.      This tells Q-Slot!
  127.           the maximum number of minutes a user can win while in the
  128.           program. If a user meets or exceeds this number, the user will
  129.           be congratulated and politely asked to try again tomorrow. The
  130.           user will not be allowed access to Q-Slot! until the next day.
  131.  
  132.           NOTE: This number does not include the time the user already has.
  133.           If this was set to 100 and the user had 99 minutes when he
  134.           entered the program, he would be allowed to win 100 minutes.
  135.  
  136.           
  137.  
  138.           Installation Continued
  139.           ──────────────────────
  140.  
  141.  
  142.           Line 4 - Maximum Daily Turns
  143.  
  144.           Max_turns is a number from 1 to 1000.  This tells Q-Slot!
  145.           the maximum number of turns a player may take per day.  If
  146.           this number is reached, the user will not be allowed to take
  147.           any more turns.
  148.  
  149.           Line 5 - External Time Bank Support
  150.  
  151.           Specifying a value of 1 on this line tells Q-Slot! that you
  152.           wish to use time bank support.  What this means is that if a
  153.           player is in Q-Slot! and wins an amount of time that would
  154.           overlap a system event, Q-Slot! will create or append a file
  155.           called THEBANK.EXT.  This file would then contain the user's
  156.           name and the number of minutes to automatically deposit into
  157.           the user's time bank account. If you don't have a TimeBank
  158.           that supports THEBANK.EXT then you might want to have a look
  159.           at Motor City Software's RATS V2.00 which is being released
  160.           at the same time as this program.
  161.  
  162.           For example, if there is a system event in 60 minutes and the
  163.           player wins 80 minutes Q-Slot! will give the player 60 minutes
  164.           of winnings and automatically bank the rest (20 minutes).
  165.  
  166.           Note: Q-Slot! will write to the THEBANK.EXT file using in the
  167.                 path specified in QSLOT.CFG.
  168.  
  169.           Line 6 - Slot Type
  170.  
  171.           You may specify one of three selection on this line.  Slot Type
  172.           specifies which slot format to use.  Valid entries for this line
  173.           are:
  174.  
  175.           PROMPT_USER     - Q-Slot! asks user which slot type to use
  176.           CITY_SLOTS      - Forces Q-Slot! to use City Slots format
  177.           TWENTY_ONE_BELL - Forces Q-Slot! to use 21 Bell format
  178.  
  179.           Twenty-One Bell Format
  180.  
  181.           This format is similar to that of the actual machine by the same
  182.           name.  It is modified slightly to include the 3-Skull combination.
  183.           Each reel contains 21 spaces.  The payoff percentage of this
  184.           format is lower than the default format (City Slots) but it is
  185.           very close to the real thing.  The 3-Cherry combination does
  186.           not exist in this format.
  187.  
  188.           City Slots Format
  189.  
  190.           City Slots has a higher payoff percentage but also has better odds
  191.           of hitting a 3-Skull combination.  The 3-Cherry combination is
  192.           allowed in this format.
  193.  
  194.  
  195.     
  196.  
  197.     ╒══════════════════════════════════════════════════════════════════════════╕
  198.     │░░░░░░ SUPPORT FILES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ Q-Slot 3.2 ░░░│
  199.     ╘══════════════════════════════════════════════════════════════════════════╛
  200.  
  201.  
  202.     The Q-Slot! archive comes with a few files needed by the program.
  203.     You can run Q-Slot! from any directory .
  204.     The files that come with the archive are:
  205.  
  206.     QSLOT.EXE                       This is the program
  207.     QSLOT01.CFG                     This is the configuration file for node 1
  208.     QSLOT.ANS                       This is the formatted graphic used
  209.     QSLOT.ASC                       This is the formatted non-graphic used
  210.     QSLOT.HLP                       This is a formatted help file
  211.     QSLOT.DOC                       This document
  212.  
  213.     NOTE: Do not edit or change the contents of QSLOT.ANS ,QSLOT.ASC
  214.           or QSLOT.HLP.  These files are formatted specifically for
  215.           the program.
  216.  
  217.     In addition to these files, Q-Slot! also creates and maintains some
  218.     files it needs to operate.  These are:
  219.  
  220.     QSLOT.DTE                       Julian date file. Erase this file if
  221.                                     you need to reset the game that day.
  222.     QSLOT.USR                       List of users who have reached a daily
  223.                                     limit and are not allowed to play again
  224.                                     that day.
  225.     QSLOT.TRN                       This keeps track of the user turn counts
  226.                                     for the day.
  227.     QSLOT.LOG                       This is the player log.  It is a circular
  228.                                     text file which tracks the last 15 players
  229.                                     and how they did.
  230.     THEBANK.EXT                     External time bank utility file.  This
  231.                                     file is created and maintained by Q-Slot!
  232.  
  233.  
  234.     
  235.  
  236.     ╒══════════════════════════════════════════════════════════════════════════╕
  237.     │░░░░░░ MORE ON TIME BANKING ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ Q-Slot 3.2 ░░░│
  238.     ╘══════════════════════════════════════════════════════════════════════════╛
  239.  
  240.  
  241.        When The Bank is run and locates THEBANK.EXT, it will read it through to
  242.     the end of the file updating or adding user accounts as needed.  The format
  243.     of THEBANK.EXT is:  User Name:Time
  244.  
  245.        For example, if JOHN DOE wins 80 minutes and Q-SLot deposits 20 minutes
  246.     into his account, the following line will be appended to THEBANK.EXT:
  247.  
  248.                                 JOHN DOE:20
  249.  
  250.        A user's name can appear in this file more than once.  The Bank will
  251.     handle it properly.  For more details, see The Bank 1.00 or later, or
  252.     RATS 1.01 or later.
  253.  
  254.  
  255.     ╒══════════════════════════════════════════════════════════════════════════╕
  256.     │░░░░░░ OTHER STUFF ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  257.     ╘══════════════════════════════════════════════════════════════════════════╛
  258.  
  259.  
  260.        Q-Slot also allows the Sysop to plug his/her BBS by displaying a file
  261.     called QSLOT.TXT, if it exists.  So, if there's a message you'd like to
  262.     display before Q-Slot draws it's screen, just create an ASCII text file
  263.     called QSLOT.TXT and put it in the same directory as Q-Slot and it will
  264.     be displayed.
  265.  
  266.  
  267.       Sysop function keys:
  268.  
  269.                [ALT]-[C] : Chat with word wrap.
  270.                            [ESC] to quit chat.
  271.                [ALT]-[H] : Hang up on user.
  272.                [ALT]-[J] : Jump to DOS.
  273.                [ALT]-[T] : Unconditionally return user to BBS.
  274.               Up Arrow   : Increase users time by 2 minutes.
  275.               Down Arrow : Decrease users time by 2 minutes.
  276.  
  277.  
  278.  
  279.     
  280.  
  281.     ╒══════════════════════════════════════════════════════════════════════════╕
  282.     │░░░░░░ NOTES FROM THE AUTHOR ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ Q-Slot 3.2 ░░░│
  283.     ╘══════════════════════════════════════════════════════════════════════════╛
  284.  
  285.  
  286.        Q-Slot has built in carrier detect and inactivity timer routines.
  287.     When tested on COM1 thru COM4, carrier detect and inactivity timers both
  288.     worked flawlessly.
  289.  
  290.        That's as far in as I'm going to go technically with this program.
  291.     Once you load it up, you will see that it is self-explainatory. The online
  292.     help file will explain the commands available and the winning combinations
  293.     and their values.  But there are a few limitations that I would like to
  294.     mention.
  295.  
  296.        Q-Slot will not allow a user with less than 3 minutes access to the
  297.     program.
  298.  
  299.        When a player enters the game, their time remaining is recorded.  They
  300.     are issued coins based on their time remaining and the coin value specified
  301.     by the Sysop.  The field "Your Time" reflects the amount of time available
  302.     for gambling purposes.  It does not affect the time the player has within
  303.     the program.  If a player has 10 minutes left when he enters the program, he
  304.     can play for 10 minutes regardless of how much time he wins.  The reason
  305.     for this is if a system event is pending in 10 minutes and the user enters
  306.     the program, then the program must return the user to the BBS in time for
  307.     that event to run.  If the user has won time, he can call back after the
  308.     system event has run and the time should still be available provided it
  309.     was not truncated by the BBS (this may be the case if no time banking
  310.     support is used).
  311.  
  312.        As always, if you have any questions, comments, or problems with this
  313.     program, feel free to contact one of the support systems listed in
  314.     SUPPORT.DOC
  315.  
  316.     
  317.